feat: support relative URI resolution in $dynamicRef (#2928)#2945
Merged
Conversation
Set ExternalResource on non-fragment $dynamicRef references so the workspace loader can discover and fetch external documents. Resolve relative URIs against hostDocument.BaseUri in Target before calling FindDocumentByBaseUri. Tests: - Fragment-only: ExternalResource is null - Absolute URI: ExternalResource is set, resolves across documents - Relative URI: ExternalResource is set, resolves against BaseUri across documents - V31 and V32 coverage
Adds 17 missing V32 test mirrors for full parity with V31 coverage. Replaces dead '?? new OpenApiWorkspace()' fallback with null-forgiving '!' in both V31 and V32 cross-document tests.
Contributor
Author
|
@baywet the actual change is in the first commit. the second commit is just mirroring the tests between V31 and V32 |
There was a problem hiding this comment.
Pull request overview
Adds support for resolving cross-document $dynamicRef values that use relative URIs by (1) capturing the external resource on deserialization so the workspace loader can fetch it, and (2) resolving relative document URIs against the host document BaseUri during $dynamicRef resolution.
Changes:
- Populate
Reference.ExternalResourcefor non-fragment$dynamicRefduring V3.1/V3.2 schema deserialization. - Update
OpenApiWorkspace.ResolveDynamicRefto resolve relative$dynamicRefdocument URIs againsthostDocument.BaseUribefore lookup. - Expand V3.2 dynamic-ref test coverage to mirror V3.1 and add cross-document relative URI resolution tests.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/Microsoft.OpenApi.Readers.Tests/V32Tests/OpenApiDynamicRefTests.cs | Adds/extends V3.2 tests, including cross-document relative $dynamicRef resolution and parity coverage. |
| test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiDynamicRefTests.cs | Adds assertions/coverage for ExternalResource and a V3.1 cross-document relative $dynamicRef test. |
| src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs | Resolves relative $dynamicRef document URIs against BaseUri before document lookup (and updates docs). |
| src/Microsoft.OpenApi/Reader/V32/OpenApiSchemaDeserializer.cs | Sets externalResource for $dynamicRef schema references (V3.2). |
| src/Microsoft.OpenApi/Reader/V31/OpenApiSchemaDeserializer.cs | Sets externalResource for $dynamicRef schema references (V3.1). |
baywet
previously approved these changes
Jul 15, 2026
baywet
left a comment
baywet
left a comment
Member
There was a problem hiding this comment.
Thanks for the contribution!
LGTM, besides copilot's comments.
…resolution Addresses Copilot review feedback on microsoft#2945.
baywet
approved these changes
Jul 15, 2026
baywet
left a comment
baywet
left a comment
Member
There was a problem hiding this comment.
Thank you for making the changes!
This was referenced Jul 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves #2928.
Extends cross-document
$dynamicRefresolution to support relative URIs (e.g.external.yaml#node). Previously only absolute URIs worked.Changes
ExternalResourceon non-fragment$dynamicRefreferences so the workspace loader can discover and fetch external documents automatically.OpenApiWorkspace.ResolveDynamicRef: Resolve relative URIs against the host documentBaseUribefore callingFindDocumentByBaseUri.Depends on
#2913 (merged in
eacc2fc0)